/*
 * ------------------------------------------------------------------------
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   06.06.2011 (meinl): created
 */
package org.knime.core.node;

import java.util.Optional;

import org.knime.core.node.context.NodeCreationConfiguration;

/**
 * This extension of {@link NodeFactory} is used in order to create a new node in a certain context. Implementors who
 * wish that their nodes can be used in a context (e.g. when a file is dropped onto the workflow editor) should extend
 * this class instead of {@link NodeFactory} and register the factory in the plugin.xml (in addition to the normal
 * registration).
 *
 * @param <T> any subclass of {@link NodeModel}
 * @author Thorsten Meinl, University of Konstanz
 * @deprecated implement {@link ConfigurableNodeFactory} instead
 */
@Deprecated
public abstract class ContextAwareNodeFactory<T extends NodeModel> extends ConfigurableNodeFactory<T> {

    @Override
    protected Optional<PortsConfigurationBuilder> createPortsConfigBuilder() {
        return Optional.empty();
    }

    @Override
    protected T createNodeModel(final NodeCreationConfiguration creationConfig) {
        // if the url config is set it cannot be null - framework takes care
        if (creationConfig.getURLConfig().isPresent()) {
            return createNodeModel(new NodeCreationContext(creationConfig.getURLConfig().get().getUrl()));
        }
        return createNodeModel();
    }

    @Override
    abstract public T createNodeModel();

    @Override
    abstract protected NodeDialogPane createNodeDialogPane();

    /**
     * Creates a new node model.
     *
     * @param context the context in which the node should be created
     * @return a node model
     */
    @Override
    public abstract T createNodeModel(final NodeCreationContext context);

    @Override
    protected NodeDialogPane createNodeDialogPane(final NodeCreationConfiguration creationConfig) {
        return createNodeDialogPane();
    }
}
